Add Hyperlink To Document
AutomatR.Word.Activities.AddHyperlinkToDocument
The "Add Hyperlink To Document" activity in AutomatR is part of the Word activities package, enabling automation processes to add hyperlinks within Microsoft Word documents. This activity simplifies the process of inserting hyperlinks with various customization options.
Properties
| Name | Description |
|---|---|
| Input | |
| Address | Specifies the hyperlink address to be added to the document. String variables containing the hyperlink address. |
| Search For Text | Specifies the text to which the hyperlink needs to be added. If specified, the hyperlink will be added relative to this text. String variables containing the text for hyperlink insertion. |
| Text To Display | Specifies the text to be displayed in the document, representing the hyperlink. String variables containing the display text for the hyperlink. |
| Insert Relative To | Specifies whether the hyperlink should be added relative to the entire document or a specific piece of text. Choose options like "Document" or "Text" from the dropdown. Enum variable of type WordAddPicInsertRelativeTo. |
| Position Where To Insert | Specifies the position where the hyperlink needs to be inserted, such as "Start," "End," "Before," "After," or "Replace." Enum variable of type WordAddPicInsertPosition. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Add Hyperlink To Document" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
How to use:
- Drag and drop the "Add Hyperlink To Document" activity onto the workflow.
- Configure the properties by specifying the hyperlink address, display text, and optional parameters.
- Choose the insertion options, such as position and relative text.
- Optionally, configure the delay before executing the activity.
- Execute the workflow to add the specified hyperlink to the Word document.
Example: Consider an example where the "Add Hyperlink To Document" activity is used to add a hyperlink to the text "Click here" with the address "https://www.example.com":
Add Hyperlink To Document:
Text To Display: "Click here"
Address: "https://www.example.com"
Position Where To Insert: "After"
Insert Relative To: "Text"
Search For Text: "Insert hyperlink here"
In this example, the activity adds a hyperlink with the text "Click here" after the occurrence of the text "Insert hyperlink here" in the Word document.